.TH std::collate_byname 3 "2024.06.10" "http://cppreference.com" "C++ Standard Libary"
.SH NAME
std::collate_byname \- std::collate_byname

.SH Synopsis
   Defined in header <locale>
   template< class CharT >
   class collate_byname : public std::collate<CharT>;

   std::collate_byname is a std::collate facet which encapsulates locale-specific
   collation (comparison) and hashing of strings. Just like std::collate, it can be
   imbued in std::regex and applied, by means of std::locale::operator(), directly to
   all standard algorithms that expect a string comparison predicate.

.SH Specializations

   The standard library is guaranteed to provide the following specializations:

   Defined in header <locale>
   std::collate_byname<char>    locale-specific collation of multibyte strings
   std::collate_byname<wchar_t> locale-specific collation of wide strings

.SH Member functions

   constructor   constructs a new collate_byname facet
                 \fI(public member function)\fP
   destructor    destroys a collate_byname facet
                 \fI(protected member function)\fP



std::collate_byname::collate_byname

   explicit collate_byname( const char* name, std::size_t refs = 0 );
   explicit collate_byname( const std::string& name, std::size_t refs =   \fI(since C++11)\fP
   0 );

   Constructs a new std::collate_byname facet for a locale with name.

   refs is used for resource management: if refs == 0, the implementation destroys the
   facet, when the last std::locale object holding it is destroyed. Otherwise, the
   object is not destroyed.

.SH Parameters

   name - the name of the locale
   refs - the number of references that link to the facet



std::collate_byname::~collate_byname

   protected:
   ~collate_byname();

   Destroys the facet.

Inherited from std::collate

.SH Member types

   Member type Definition
   char_type   CharT
   string_type std::basic_string<CharT>

.SH Member functions

   compare   invokes do_compare
             \fI(public member function of std::collate<CharT>)\fP
   transform invokes do_transform
             \fI(public member function of std::collate<CharT>)\fP
   hash      invokes do_hash
             \fI(public member function of std::collate<CharT>)\fP

.SH Protected member functions

   do_compare   compares two strings using this facet's collation rules
   \fB[virtual]\fP    \fI(virtual protected member function of std::collate<CharT>)\fP
   do_transform transforms a string so that collation can be replaced by comparison
   \fB[virtual]\fP    \fI(virtual protected member function of std::collate<CharT>)\fP
   do_hash      generates an integer hash value using this facet's collation rules
   \fB[virtual]\fP    \fI(virtual protected member function of std::collate<CharT>)\fP

.SH Notes

   Collation order is the dictionary order: the position of the letter in the national
   alphabet (its equivalence class) has higher priority than its case or variant.
   Within an equivalence class, lowercase characters collate before their uppercase
   equivalents and locale-specific order may apply to the characters with diacritics.
   In some locales, groups of characters compare as single collation units. For
   example, "ch" in Czech follows "h" and precedes "i", and "dzs" in Hungarian follows
   "dz" and precedes "g".

.SH Example

    This section is incomplete
    Reason: no example

.SH See also

   collate    defines lexicographical comparison and hashing of strings
              \fI(class template)\fP
   strcoll    compares two strings in accordance to the current locale
              \fI(function)\fP
   wcscoll    compares two wide strings in accordance to the current locale
              \fI(function)\fP
   operator() lexicographically compares two strings using this locale's collate facet
              \fI(public member function of std::locale)\fP

.SH Category:
     * Todo no example
